.TH lha_startnode 1 "19 April 2012" "TrueCL Commands"

.SH NAME
lha_startnode \- Join a node to currently running Cluster.

.SH SYNOPSES
.TS
l l.
lha_startnode	[\fB-N|--node\fP \fIX\fP] [\fB--jointime\fP \fIN\fP] [\fB--timeout\fP \fIN\fP]
	[\fB--force\fP] [\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP]
	[\fB--lwidth\fP \fIN\fP]
.TE

.SH DESCRIPTION
The \fIlha_startnode(1)\fP command is used as a convenience function to calling the
\fIlha_form(1)\fP utility with the correct parameters for the node in question
to join a currently running cluster.

It does perform some sanity checking and if appropriate will call the \fIlha_form(1)\fP
command.

.SH ARGUMENTS
.TP 8
--node
Indicates the node that is to be added to the cluster. If not specified it
will default to adding the current node the command is bein executed on.

.TP
--jointime
The maximum amount of time (in seconds) to wait for the node in question to be
considered as part of the cluster. If cluster joining does not occur in this 
period the process will be aborted. 

The default is determined by whether the cluster parameter "Form time" and if that
is not set will default to 120 seconds.

.TP
--timeout
The length of time to wait for individual requests from various cluster daemons.
The default is 10 (seconds) if not specified on the command line.

.TP
--debug
Run the node addition in 'debug' mode - might produce significant levels 
of output to the standard output device, most of which is only useful for
developers.

.TP
--verbose
Verbose mode generates a sensible amount of output to standard output to 
show the progress of node addition to the cluster. This is the recommended flag if
the administrator wishes to see 'progress' output.
.TP
--quiet
This will only produce errors and warnings on the standard output device.
.TP
--silent
Only produce output if fatal errors occur during attempted addition of the 
node to the cluster. 

.SH OUTPUT
In verbose mode the utility will show the addition of the node from to the 
cluster.

.SH EXIT CODES
If the node is successfully added into the running cluster then 0 (success) will
be returned. Any non-zero value indicates a failure to complete the
requested node addition.

.SH FILES
No particular special files are used/generated by this utility.

.SH NOTES
The time taken for this action to complete is highly dependent on the arguments
specified and how many nodes are defined as part of the cluster, the load on the 
existing nodes and the timeout values used.

.SH AUTHOR
The TrueCL software was written by Simon Edwards, (C) 2006-2012, working
for Advantsys Computer Services Ltd - www.advantsys.co.uk.

.SH SEE ALSO
.BR lha_startapp(1),
.BR lha_form(1).

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP. For
more information, please see the following page: truecl.advantsys.co.uk.

